Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add install size badge to readme #48

Merged
merged 7 commits into from
Oct 9, 2018
Merged

Add install size badge to readme #48

merged 7 commits into from
Oct 9, 2018

Conversation

MichalLytek
Copy link
Contributor

This PR adds a very important badge that will inform library consumers about the install size of the npm package.

@pkosiec
Copy link
Owner

pkosiec commented Oct 7, 2018

Hi @19majkel94! ✋Thank you for your contribution!

I don't know if this badge is really that important, but... if you say so, then let's merge it 😄Can you add it to CLI Readme as well (in the same PR)?

Also, could you please rebase your PR to latest master? I fixed Travis configuration for building PRs from forks. Now the build should be green. Thanks!

@pkosiec pkosiec added the 📖 documentation All activites around documentation label Oct 7, 2018
Copy link
Owner

@pkosiec pkosiec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix marked issues. Thanks!

README.md Outdated
@@ -2,7 +2,7 @@

# Mongo Seeding

[![GitHub version](https://badge.fury.io/gh/pkosiec%2Fmongo-seeding.svg)](https://badge.fury.io/gh/pkosiec%2Fmongo-seeding) [![Build Status](https://travis-ci.org/pkosiec/mongo-seeding.svg?branch=master)](https://travis-ci.org/pkosiec/mongo-seeding) [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
[![GitHub version](https://badge.fury.io/gh/pkosiec%2Fmongo-seeding.svg)](https://badge.fury.io/gh/pkosiec%2Fmongo-seeding) [![Build Status](https://travis-ci.org/pkosiec/mongo-seeding.svg?branch=master)](https://travis-ci.org/pkosiec/mongo-seeding) [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/) [![install size](https://packagephobia.now.sh/badge?p=mongo-seeding)](https://packagephobia.now.sh/result?p=mongo-seeding)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This badge should be moved to core/README.md, as it is related to only JS library.

cli/README.md Outdated
@@ -2,7 +2,7 @@

# Mongo Seeding CLI

[![npm version](https://badge.fury.io/js/mongo-seeding-cli.svg)](https://npmjs.org/package/mongo-seeding-cli) [![David](https://img.shields.io/david/pkosiec/mongo-seeding.svg?path=cli)]() [![David](https://img.shields.io/david/dev/pkosiec/mongo-seeding.svg?path=cli)]()
[![npm version](https://badge.fury.io/js/mongo-seeding-cli.svg)](https://npmjs.org/package/mongo-seeding-cli) [![David](https://img.shields.io/david/pkosiec/mongo-seeding.svg?path=cli)]() [![David](https://img.shields.io/david/dev/pkosiec/mongo-seeding.svg?path=cli)]() [![install size](https://packagephobia.now.sh/badge?p=mongo-seeding)](https://packagephobia.now.sh/result?p=mongo-seeding)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CLI has a different package name: mongo-seeding-cli

@pkosiec pkosiec merged commit 679e775 into pkosiec:master Oct 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation All activites around documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants